home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 2.iso / dist / fw_libpcap.idb / usr / freeware / include / pcap.h.z / pcap.h
C/C++ Source or Header  |  2002-04-08  |  7KB  |  211 lines
  1. /* -*- Mode: c; tab-width: 8; indent-tabs-mode: 1; c-basic-offset: 8; -*- */
  2. /*
  3.  * Copyright (c) 1993, 1994, 1995, 1996, 1997
  4.  *    The Regents of the University of California.  All rights reserved.
  5.  *
  6.  * Redistribution and use in source and binary forms, with or without
  7.  * modification, are permitted provided that the following conditions
  8.  * are met:
  9.  * 1. Redistributions of source code must retain the above copyright
  10.  *    notice, this list of conditions and the following disclaimer.
  11.  * 2. Redistributions in binary form must reproduce the above copyright
  12.  *    notice, this list of conditions and the following disclaimer in the
  13.  *    documentation and/or other materials provided with the distribution.
  14.  * 3. All advertising materials mentioning features or use of this software
  15.  *    must display the following acknowledgement:
  16.  *    This product includes software developed by the Computer Systems
  17.  *    Engineering Group at Lawrence Berkeley Laboratory.
  18.  * 4. Neither the name of the University nor of the Laboratory may be used
  19.  *    to endorse or promote products derived from this software without
  20.  *    specific prior written permission.
  21.  *
  22.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32.  * SUCH DAMAGE.
  33.  *
  34.  * @(#) $Header: /tcpdump/master/libpcap/pcap.h,v 1.34 2001/12/09 05:10:03 guy Exp $ (LBL)
  35.  */
  36.  
  37. #ifndef lib_pcap_h
  38. #define lib_pcap_h
  39.  
  40. #include <sys/types.h>
  41. #include <sys/time.h>
  42.  
  43. #include <net/bpf.h>
  44.  
  45. #include <stdio.h>
  46.  
  47. #ifdef __cplusplus
  48. extern "C" {
  49. #endif
  50.  
  51. #define PCAP_VERSION_MAJOR 2
  52. #define PCAP_VERSION_MINOR 4
  53.  
  54. #define PCAP_ERRBUF_SIZE 256
  55.  
  56. /*
  57.  * Compatibility for systems that have a bpf.h that
  58.  * predates the bpf typedefs for 64-bit support.
  59.  */
  60. #if BPF_RELEASE - 0 < 199406
  61. typedef    int bpf_int32;
  62. typedef    u_int bpf_u_int32;
  63. #endif
  64.  
  65. typedef struct pcap pcap_t;
  66. typedef struct pcap_dumper pcap_dumper_t;
  67. typedef struct pcap_if pcap_if_t;
  68. typedef struct pcap_addr pcap_addr_t;
  69.  
  70. /*
  71.  * The first record in the file contains saved values for some
  72.  * of the flags used in the printout phases of tcpdump.
  73.  * Many fields here are 32 bit ints so compilers won't insert unwanted
  74.  * padding; these files need to be interchangeable across architectures.
  75.  *
  76.  * Do not change the layout of this structure, in any way (this includes
  77.  * changes that only affect the length of fields in this structure).
  78.  *
  79.  * Also, do not change the interpretation of any of the members of this
  80.  * structure, in any way (this includes using values other than
  81.  * LINKTYPE_ values, as defined in "savefile.c", in the "linktype"
  82.  * field).
  83.  *
  84.  * Instead:
  85.  *
  86.  *    introduce a new structure for the new format, if the layout
  87.  *    of the structure changed;
  88.  *
  89.  *    send mail to "tcpdump-workers@tcpdump.org", requesting a new
  90.  *    magic number for your new capture file format, and, when
  91.  *    you get the new magic number, put it in "savefile.c";
  92.  *
  93.  *    use that magic number for save files with the changed file
  94.  *    header;
  95.  *
  96.  *    make the code in "savefile.c" capable of reading files with
  97.  *    the old file header as well as files with the new file header
  98.  *    (using the magic number to determine the header format).
  99.  *
  100.  * Then supply the changes to "patches@tcpdump.org", so that future
  101.  * versions of libpcap and programs that use it (such as tcpdump) will
  102.  * be able to read your new capture file format.
  103.  */
  104. struct pcap_file_header {
  105.     bpf_u_int32 magic;
  106.     u_short version_major;
  107.     u_short version_minor;
  108.     bpf_int32 thiszone;    /* gmt to local correction */
  109.     bpf_u_int32 sigfigs;    /* accuracy of timestamps */
  110.     bpf_u_int32 snaplen;    /* max length saved portion of each pkt */
  111.     bpf_u_int32 linktype;    /* data link type (LINKTYPE_*) */
  112. };
  113.  
  114. /*
  115.  * Each packet in the dump file is prepended with this generic header.
  116.  * This gets around the problem of different headers for different
  117.  * packet interfaces.
  118.  */
  119. struct pcap_pkthdr {
  120.     struct timeval ts;    /* time stamp */
  121.     bpf_u_int32 caplen;    /* length of portion present */
  122.     bpf_u_int32 len;    /* length this packet (off wire) */
  123. };
  124.  
  125. /*
  126.  * As returned by the pcap_stats()
  127.  */
  128. struct pcap_stat {
  129.     u_int ps_recv;        /* number of packets received */
  130.     u_int ps_drop;        /* number of packets dropped */
  131.     u_int ps_ifdrop;    /* drops by interface XXX not yet supported */
  132. };
  133.  
  134. /*
  135.  * Item in a list of interfaces.
  136.  */
  137. struct pcap_if {
  138.     struct pcap_if *next;
  139.     char *name;        /* name to hand to "pcap_open_live()" */
  140.     char *description;    /* textual description of interface, or NULL */
  141.     struct pcap_addr *addresses;
  142.     u_int flags;        /* PCAP_IF_ interface flags */
  143. };
  144.  
  145. #define PCAP_IF_LOOPBACK    0x00000001    /* interface is loopback */
  146.  
  147. /*
  148.  * Representation of an interface address.
  149.  */
  150. struct pcap_addr {
  151.     struct pcap_addr *next;
  152.     struct sockaddr *addr;        /* address */
  153.     struct sockaddr *netmask;    /* netmask for that address */
  154.     struct sockaddr *broadaddr;    /* broadcast address for that address */
  155.     struct sockaddr *dstaddr;    /* P2P destination address for that address */
  156. };
  157.  
  158. typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
  159.                  const u_char *);
  160.  
  161. char    *pcap_lookupdev(char *);
  162. int    pcap_lookupnet(char *, bpf_u_int32 *, bpf_u_int32 *, char *);
  163. pcap_t    *pcap_open_live(char *, int, int, int, char *);
  164. pcap_t    *pcap_open_dead(int, int);
  165. pcap_t    *pcap_open_offline(const char *, char *);
  166. void    pcap_close(pcap_t *);
  167. int    pcap_loop(pcap_t *, int, pcap_handler, u_char *);
  168. int    pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
  169. const u_char*
  170.     pcap_next(pcap_t *, struct pcap_pkthdr *);
  171. int    pcap_stats(pcap_t *, struct pcap_stat *);
  172. int    pcap_setfilter(pcap_t *, struct bpf_program *);
  173. int    pcap_getnonblock(pcap_t *, char *);
  174. int    pcap_setnonblock(pcap_t *, int, char *);
  175. void    pcap_perror(pcap_t *, char *);
  176. char    *pcap_strerror(int);
  177. char    *pcap_geterr(pcap_t *);
  178. int    pcap_compile(pcap_t *, struct bpf_program *, char *, int,
  179.         bpf_u_int32);
  180. int    pcap_compile_nopcap(int, int, struct bpf_program *,
  181.         char *, int, bpf_u_int32);
  182. void    pcap_freecode(struct bpf_program *);
  183. int    pcap_datalink(pcap_t *);
  184. int    pcap_snapshot(pcap_t *);
  185. int    pcap_is_swapped(pcap_t *);
  186. int    pcap_major_version(pcap_t *);
  187. int    pcap_minor_version(pcap_t *);
  188.  
  189. /* XXX */
  190. FILE    *pcap_file(pcap_t *);
  191. int    pcap_fileno(pcap_t *);
  192.  
  193. pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
  194. void    pcap_dump_close(pcap_dumper_t *);
  195. void    pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
  196.  
  197. int    pcap_findalldevs(pcap_if_t **, char *);
  198. void    pcap_freealldevs(pcap_if_t *);
  199.  
  200. /* XXX this guy lives in the bpf tree */
  201. u_int    bpf_filter(struct bpf_insn *, u_char *, u_int, u_int);
  202. int    bpf_validate(struct bpf_insn *f, int len);
  203. char    *bpf_image(struct bpf_insn *, int);
  204. void    bpf_dump(struct bpf_program *, int);
  205.  
  206. #ifdef __cplusplus
  207. }
  208. #endif
  209.  
  210. #endif
  211.